Fix/docs tutorial walkthrough - #52
Merged
Merged
Conversation
The docify new command generated a docusaurus.config.ts referencing ./sidebars.ts but never created the file, causing every scaffolded project to fail on build. This commit: - Adds sidebars.ts (autogenerated sidebar) to the scaffold output - Replaces the deprecated onBrokenMarkdownLinks location with markdown.hooks.onBrokenMarkdownLinks - Changes the scaffolded routeBasePath from /docs to / so the docs index serves as the homepage (avoids a broken-link error on /) - Adds npm run alternatives to the quick-start, add-docset, and add-playground guides for users without the CLI installed - Adds local npm link instructions to the quick-start since @devdocify/cli is not yet published to npm - Lists sidebars.ts in the CLI reference docify new output Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
… run alternatives to docs
The root .gitignore only ignored /node_modules (root-scoped), so packages/cli/node_modules got committed when CLI deps were installed during testing. Add packages/*/node_modules to .gitignore to prevent recurrence. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Preview deployment
Updated on each push to this PR. |
The CLI is not published to npm, so the tutorial should give direct instructions rather than hedging with "if published." Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Step 1 leaves you in packages/cli/, so without navigating first the project gets created in the wrong place. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
If dependencies are not installed, docify dev/build/validate show a cryptic "command not found" error. Now assertProject checks for node_modules and tells the user to run npm install. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docify newscaffold: add missingsidebars.tsgeneration, fix deprecated top-levelonBrokenMarkdownLinks(moved tomarkdown.hooks), changerouteBasePathfrom'docs'to'/'to prevent broken-link error on homepage, and switch navbar item totype: 'doc'npm runalternatives to docs: since@devdocify/cliis not published to npm, add localnpm linkinstructions to the quick-start tutorial andnpm runfallbacks to quick-start, add-docset, and add-playground guidessidebars.tsto the list of files generated bydocify new.gitignore: addpackages/*/node_modulesandpackages/*/package-lock.jsonto prevent nested dependencies from being committedHow it was tested
Ran the full quick-start tutorial end-to-end in a temp directory:
npm linkthe CLI frompackages/cli/docify new my-docs && cd my-docs && npm installnpx docusaurus build-- confirmed clean build with no errorsdocify validateanddocify broken-linkscomplete without errorsnpm runalternatives are accurateTest plan
docify new test-project && cd test-project && npm install && npx docusaurus buildsucceedsnpm linkpath